Metadata-Version: 2.1
Name: django-user-auth-asl2
Version: 0.1.2
Summary: A Django app to conduct web-based user authentication.
Home-page: https://asl.aero
Author: Nasir Khan
Author-email: nasirkhan97.bd@gmail.com
License: NasirTitas2022
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 4.0
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Requires-Python: >=3.8
License-File: LICENSE

==========
User Auth
==========

User Auth is a Django app to conduct web-based User Auth. For each question,
visitors can choose between a fixed number of answers.

Detailed documentation is in the "docs" directory.

Quick start
-----------
1. Dependency you have to install: ``pip install django-phonenumber-field djangorestframework djangorestframework-simplejwt phonenumbers django-rest-passwordreset Pillow``
1. Add "User Auth" to your INSTALLED_APPS setting like this::

    INSTALLED_APPS = [
        ...
        'django_rest_passwordreset',
        'phonenumber_field',
        'user',

    ]

2. Include the User Auth URLconf in your project urls.py like this::
    from django.urls import include
    path('api/user/', include('user.urls')),

3. Include the following line in your project settings.py like this::

    AUTH_USER_MODEL = 'user.User'

4. Run ``python manage.py makemigrations`` and ``python manage.py migrate`` to create the User Auth models.

5. Start the development server and visit http://127.0.0.1:8000/admin/
   to create a user (you'll need the Admin app enabled).

6. Visit http://127.0.0.1:8000/api/user/ to participate in the user auth.

7. all the url for particular action is given below,
    user registration, url: http://127.0.0.1:8000/api/user/users/ , method: post, body: 
    login, url: http://127.0.0.1:8000/api/user/auth/ , method: post, body: username,password
    update profile , http://127.0.0.1:8000/api/user/update_profile/ , method: post
    get user role, http://127.0.0.1:8000/api/user/user_role/ , method: get
    path('change_password/',change_password),

    path('token/refresh/', TokenRefreshView.as_view(), name='token_refresh'),
    path('password_reset/', include('django_rest_passwordreset.urls', namespace='password_reset')),

